Create a Product

To create a new warehouse product, you can make a POST request to the /warehouse/v1/products endpoint. The JSON payload for this request should include at minimum the following fields: productCode, productDescription, and productUnit. Here's an example of how the request should look:

Please note that the productCode field has a maximum length of 35 characters.

Example Request

POST /warehouse/v1/products HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Content-Type: application/json

{
    "productCode": "LGT-K380-BT-KYBD",
    "productDescription": "Logitech K380 Multi-Device Bluetooth Keyboard",
    "productUnit": "UNT",
    "unitPrice": "39.99",
    "unitPriceCurrency": "USD",
    "dimHeight": 0.58,
    "dimWidth": 10.91,
    "dimDepth": 4.93,
    "dimUnit": "IN",
    "weightPerProduct": 0.9,
    "weightPerProductUnit": "LB",
    "clientProductCode": "097855114990",
    "clientProductDescription": "Logitech K380 Multi-Device Bluetooth Keyboard",
    "clientProductUnit": "UNT"
}

Please ensure your productCode is within the character limit to avoid any validation errors. Replace your_api_key with your actual API key and your_organization_slug with your organization slug, if required.

If the request is successful, you will receive a 200 OK status code and a JSON response containing the newly created product.

Example Response

{
    "data": {
        "id": "6434b470dd3283f909d1b915",
        "productCode": "LGT-K380-BT-KYBD",
        "productDescription": "Logitech K380 Multi-Device Bluetooth Keyboard",
        "productUnit": "UNT",
        "unitPrice": "39.99",
        "unitPriceCurrency": "USD",
        "productAttributes": [],
        "dimHeight": 0.58,
        "dimWidth": 10.91,
        "dimDepth": 4.93,
        "dimUnit": "IN",
        "weightPerProduct": 0.9,
        "weightPerProductUnit": "LB",
        "clientProductCode": "097855114990",
        "clientProductDescription": "Logitech K380 Multi-Device Bluetooth Keyboard",
        "clientProductUnit": "UNT"
    },
    "id": "f758d2895f344fe2899ee64d1921b83c",
    "resource": [],
    "errors": []
}